Favicon

You are here: Home > API Reference > Platform > Organization Storageproviders > Update storageProvider

Update storageProvider

Required Permission: base.organization.storageProvider.update

Update storageProvider

PUT
https://api.applivery.io/v1/organizations/{organizationId}/storage-providers/{storageProviderId} 
curl -X PUT "https://api.applivery.io/v1/organizations/{organizationId}/storage-providers/{storageProviderId}" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "description": "string",
  "provider": "s3",
  "organization": "string",
  "s3Configuration": {
    "security": {},
    "privateBucket": "string",
    "publicBucket": "string"
  },
  "gcsConfiguration": {
    "security": {},
    "bucket": "string",
    "region": "string"
  }
}'
const response = await fetch("https://api.applivery.io/v1/organizations/{organizationId}/storage-providers/{storageProviderId}", {
  method: "PUT",
  headers: {
    Authorization: "Bearer <YOUR_API_KEY>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "string",
    "description": "string",
    "provider": "s3",
    "organization": "string",
    "s3Configuration": {
      "security": {},
      "privateBucket": "string",
      "publicBucket": "string"
    },
    "gcsConfiguration": {
      "security": {},
      "bucket": "string",
      "region": "string"
    }
  }),
});

const data = await response.json();
import requests

response = requests.put(
    "https://api.applivery.io/v1/organizations/{organizationId}/storage-providers/{storageProviderId}",
    headers={"Authorization": "Bearer <YOUR_API_KEY>"},
    json={
      "name": "string",
      "description": "string",
      "provider": "s3",
      "organization": "string",
      "s3Configuration": {
        "security": {},
        "privateBucket": "string",
        "publicBucket": "string"
      },
      "gcsConfiguration": {
        "security": {},
        "bucket": "string",
        "region": "string"
      }
    },
)

data = response.json()

Request

Send your API key in the request header authorization
Example: Authorization: Bearer <token>

organizationId string
required
Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$
storageProviderId string
required
Match pattern: ^[a-fA-F0-9]{24}$

Body Params application/json
name string optional
≤ 128 characters
description string optional
≤ 500 characters
provider string optional
s3 gcs
organization string optional
Match pattern: ^[a-fA-F0-9]{24}$
s3Configuration object optional
security object optional
secretAccessKey string optional
≤ 128 characters
accessKeyId string optional
≤ 128 characters
region string optional
≤ 128 characters
privateBucket string optional
≤ 128 characters
publicBucket string optional
≤ 128 characters
gcsConfiguration object optional
security object optional
accessKey string optional
≤ 128 characters
secret string optional
≤ 128 characters
region string optional
≤ 128 characters
bucket string optional
≤ 128 characters
region string optional
≤ 128 characters
{
    "name": "string",
    "description": "string",
    "provider": "s3",
    "organization": "string",
    "s3Configuration": {
        "security": {
            "secretAccessKey": "string",
            "accessKeyId": "string",
            "region": "string"
        },
        "privateBucket": "string",
        "publicBucket": "string"
    },
    "gcsConfiguration": {
        "security": {
            "accessKey": "string",
            "secret": "string",
            "region": "string"
        },
        "bucket": "string",
        "region": "string"
    }
}

Responses

200 Response application/json
status boolean optional
data object optional
id string optional
Match pattern: ^[a-fA-F0-9]{24}$
name string optional
≤ 128 characters
description string optional
≤ 500 characters
organization string optional
Match pattern: ^[a-fA-F0-9]{24}$
provider string optional
s3 gcs
type string optional
default custom
default boolean optional
s3Configuration object optional
security object optional
privateBucket string optional
≤ 128 characters
publicBucket string optional
≤ 128 characters
buildTempFolder string optional
≤ 128 characters
logoFolder string optional
≤ 128 characters
gcsConfiguration object optional
security object optional
bucket string optional
≤ 128 characters
cloudCdn object optional
updatedAt string optional
Format: date-time
createdAt string optional
Format: date-time
{
    "status": true,
    "data": {
        "id": "string",
        "name": "string",
        "description": "string",
        "organization": "string",
        "provider": "s3",
        "type": "default",
        "default": true,
        "s3Configuration": {
            "security": {
                "secretAccessKey": "string",
                "accessKeyId": "string",
                "region": "string"
            },
            "privateBucket": "string",
            "publicBucket": "string",
            "buildTempFolder": "string",
            "logoFolder": "string"
        },
        "gcsConfiguration": {
            "security": {
                "accessKey": "string",
                "secret": "string",
                "region": "string"
            },
            "bucket": "string",
            "cloudCdn": {
                "url": "string",
                "keyName": "string",
                "keyValue": "string"
            }
        },
        "updatedAt": "2024-01-01T00: 00:00Z",
        "createdAt": "2024-01-01T00: 00:00Z"
    }
}
400 Response application/json
status boolean optional
false
error object optional
code number optional
6002
message string optional
Body Validation Error
{
    "status": false,
    "error": {
        "code": 6002,
        "message": "Body Validation Error"
    }
}
401 Response application/json
status boolean optional
false
error object optional
code number optional
4004
message string optional
Invalid Token
{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}
404 Response application/json
status boolean optional
false
error object optional
code number optional
3001
message string optional
Entity not found
{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}